home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / programming / c / proman22.lha / ProjectMan22 / SASCProjectMan.doc < prev    next >
Encoding:
Text File  |  1993-11-11  |  6.6 KB  |  168 lines
  1.                          SASCProjectManager
  2.                          ==================
  3.  
  4.                          ©1993 Donald Milne
  5.  
  6.  
  7. Please see the readme file for important copyright information.
  8.  
  9. This is v2.2 of a project manager for SAS/C v6.0 or greater. It is freely
  10. distributable within the limits given in the readme file.
  11.  
  12. Introduction
  13. ------------
  14.  
  15. This is a front end to simplify maintenance and building of SAS/C projects,
  16. particularly those with multiple source files and headers. It allows the
  17. user to construct a list of source files that make up the project and
  18. to define global and local compiler options for these files. It can also
  19. build a list of #includ'ed local headers (those in "...") and use all this
  20. information to construct a make file.
  21.  
  22. The user can compile individual files, link the project, build the project
  23. via smake, set global compiler and linker options and set local compiler
  24. options on a file by file basis. The user can also edit both source files
  25. (.c/.cpp) and header files.
  26.  
  27. The makefile that the program consructs ensures that any changes to the
  28. source files, local headers, local options and global options will result
  29. in the recompilation and relinking of all affected parts of the source code.
  30.  
  31. Installation
  32. ------------
  33.  
  34. 1) Copy 'SASCProjectManager' to SC:C/.
  35. 2) Delete the SC:Starter_Project drawer.
  36. 3) Copy the supplied Starter_Project drawer to SC:
  37.  
  38. When the SCSetUp program is used to create a new project, the files in
  39. the new Starter_Project drawer will be used. The Build, Edit and SCoptions
  40. icons are replaced with the ProjectMan icon.
  41.  
  42. Using The Program
  43. -----------------
  44.  
  45. Create your source files using the 'Operation/Edit New File...' menu item.
  46. Once you have at least one source file you can double click on the ProjectMan
  47. icon. A window will appear with a large scrolling list and several buttons.
  48.  
  49. Select Project/Add Item... (Amiga A) and a file requester will appear. Use
  50. this to select a source file and click OK. The file will be added to the
  51. scrolling list. The file requester supports multi-selection of files using
  52. the shift key.
  53.  
  54. Another alternative is to drag the icon(s) for the file(s) into the
  55. ProjectMan window as the window is an AppWindow and supports drag and
  56. drop of icons.
  57.  
  58. Note that only files matching '#?.c' or (new in v2.1) '#?.cpp' will be
  59. displayed in the file requester and the AppWindow will ignore any file
  60. dropped in it that fails to match one of these patterns.
  61.  
  62. When you are ready to compile something, select Operation/Global Options...
  63. (Amiga G). This will run the normal SCOpts program and allow you to set
  64. the options that all source files will be compiled and linked with. Next
  65. select the source file you wish to compile from the list then click on
  66. the Compile button. A window will open in which the compiler output will
  67. be displayed. When the compiler is finished, close the window using its
  68. close gadget. It is recommended that you turn on the verbose option in
  69. SCOpts otherwise it will not be obvious when the compiler has finished.
  70.  
  71. Use the Make button to recompile and relink all files that require it,
  72. using smake.
  73.  
  74. Use the Link button to relink all object files.
  75.  
  76. Use the Build button to recompile and relink all files whether it is
  77. required or not, a requester will prompt you before comencing with this
  78. operation. If you do not have a real-time clock then you should use this
  79. option the first time you do a compile in order to set the correct
  80. datestamps on the object files and the executable.
  81.  
  82. The Show Headers button will scan the selected file and display a list of
  83. all files that are #include'ed in "..." in a scrolling list in a seperate
  84. window. Click on Done to return to the main window. Note that only the source
  85. file will be searched, any files it #include's will not be searched so
  86. header files should not #include any non-system headers of their own.
  87. (System headers in <...> are ok however as these are not scanned for).
  88. The Edit button can be used to edit (via se) the currently selected header
  89. file.
  90.  
  91. The Local Options button runs the SCOpts program and allows the setting
  92. of options local to s source file. The source file must be selected before
  93. clicking on this button.
  94.  
  95. The Edit Files button allows the editing (via se) of the currently selected
  96. source file.
  97.  
  98. The Operation menu has entries that perform the same actions as these
  99. buttons as well as an entry for gloabl options and the edit new file option.
  100.  
  101. The Project menu has the add item entry but also has a 'Delete Item...'
  102. entry (Amiga D) to remove source files from the list (it does not actually
  103. delete the source file itself however), an 'About...' item which does the
  104. same as in any other program, an 'Iconify' entry (Amiga I) which reduces
  105. the window to an AppIcon on the workbench (double click on it to get the
  106. window back) and a 'Quit...' option (Amiga Q) which performs the same action
  107. as the window close gadget.
  108.  
  109. Notes
  110. -----
  111.  
  112. The program creates several files.
  113.  
  114. ProjectMan - this is the data file assosciated with the icon and it
  115.              contains the source file list.
  116.  
  117. GLOBALOPTS - this is the global options file.
  118.  
  119. <sourcefile>.lopt - this is the local options file assosiated with a
  120.                     source file.
  121.  
  122. smakefile - the created makefile passes to smake.
  123.  
  124. <projectname>.lnk - the command file passes to slink.
  125.  
  126. The SCOpts program creates an SCOptions file but this is renamed to either
  127. GLOBALOPTS or <sourcefile>.lopt by this program.
  128.  
  129. You may see a 'sc:c/sc failed returncode 10' message in the output window
  130. just before the linker runs, this is ok, the program uses 'sc' to build
  131. the <projectname>.lnk file and 'sc' fails because it cannot find 'slink'
  132. as there are no paths set up in a workbench process.
  133.  
  134. It is also recommended that you give the project a name in the global
  135. options to avoid problems, If the project is not given a name, it will
  136. be named after the first source file in the list and if this changes
  137. then the compiler etc may become confused (not to mention that you will
  138. get multiple copies of your executable and '.lnk' files).
  139.  
  140. Archive Contents
  141. ----------------
  142.  
  143. ProjectMan.info
  144. ProjectMan/Starter_Project.info
  145. ProjectMan/Starter_Project/Debug
  146. ProjectMan/Starter_Project/Debug.info
  147. ProjectMan/Starter_Project/ProjectMan.info
  148. ProjectMan/README                            (distribution notes)
  149. ProjectMan/README.info
  150. ProjectMan/SASCProjectMan.doc                (this file)
  151. ProjectMan/SASCProjectMan.doc.info
  152. ProjectMan/SASCProjectManager                (the program)
  153.  
  154. Contact Details
  155. ---------------
  156.  
  157. You can contact me by mailing 'donald' on the Alpha Complex BBS on
  158. 0224-626203 (UK).
  159.  
  160. Thanks
  161. ------
  162.  
  163. Thanks to :
  164.     Commodore-Amiga for the machine.
  165.     SAS Institute for the compiler.
  166.     Al for letting me recompile my 5.10 source under 6.3.
  167.     Gary for the suggestions.
  168.